home *** CD-ROM | disk | FTP | other *** search
/ Aminet 45 / Aminet 45 (2001)(GTI - Schatztruhe)[!][Oct 2001].iso / Aminet / dev / misc / uncat.readme < prev   
Text File  |  2001-09-05  |  6KB  |  196 lines
  1. Short:    Create .cd file from running program
  2. Author:   thomas-rapp@web.de (Thomas Rapp)
  3. Uploader: thomas-rapp@web.de (Thomas Rapp)
  4. Version:  0.2
  5. Type:     dev/misc
  6. Requires: AmigaOS 2.1+
  7.  
  8.  
  9. Introduction
  10. ============
  11.  
  12. Did you ever download or even buy a program and the author promised to
  13. deliver some language catalogs but didn't do so for a long time ?
  14.  
  15. Then this is the solution for you: UnCat patches the locale.library 
  16. and catches all calls to it concerning translation. Then it creates
  17. a .cd file which you can use to create a new language catalog file.
  18.  
  19. Note: UnCat can only be used with programs that are already prepared
  20.       to be localised and use locale.library. It is not meant for 
  21.       developers that want to create localisation for their program.
  22.  
  23. Patched functions:
  24.  
  25.    OpenCatalogA   for the catalog name and version
  26.  
  27.    GetCatalogStr  for the string IDs and builtin strings
  28.  
  29.  
  30. New in Release 2
  31. ================
  32.  
  33. - Fixed some enforcer Hits. Strings are now copied to the message instead
  34.   of using pointers into foreign memory.
  35.  
  36.  
  37. Disclaimer
  38. ==========
  39.  
  40.   - The program is Freeware. Please do not distibute the program without
  41.     the readme file.
  42.  
  43.   - The program was only tested by me on my machine. There is no guarantee 
  44.     that it runs on others. I am not responsible for any damage. Use it on 
  45.     your own risk.
  46.  
  47.   - It might not be legal to reengineer someone's program in the way UnCat 
  48.     does, in order to translate its strings to another language. I am not
  49.     reponsible for any actions that others do with my program.
  50.  
  51.   - I would be very pleased if you send me german catalog files that you
  52.     created using my program.
  53.  
  54.  
  55. Installation
  56. ============
  57.  
  58. Copy the UnCat executable to your C: directory or to some other place
  59. in your DOS path.
  60.  
  61.  
  62. Procedure
  63. =========
  64.  
  65. - Read the "Important" section of this readme !!!
  66.  
  67. - Start UnCat naming the program you want to monitor and the .cd file
  68.   you want to create.
  69.  
  70. - Start the program and use it. Try to see as many strings as possible.
  71.   Only strings that are referred by the program will appear in the
  72.   .cd file.
  73.  
  74. - Stop UnCat.
  75.  
  76. - Use the created .cd file to create a new language catalog file.
  77.  
  78.  
  79. Usage
  80. =====
  81.  
  82. UnCat must be called from a Shell window. When called, UnCat installs
  83. its patches and then waits. When you press Ctrl-C, the patches are 
  84. removed and UnCat is stopped.
  85.  
  86.  
  87. Parameters
  88. ==========
  89.  
  90. TASK/A       Pattern for the task name to be monitored. May contain
  91.              AmigaDOS wildcards.
  92.  
  93. FILE/A       Filename to be written containing the catalog description.
  94.              Should end with .cd
  95.  
  96. MAXID/N      If the .cd file contains duplicate string IDs, the monitored
  97.              program uses more than 5000 strings. Use this parameter to enter
  98.              a number greater than 5000.
  99.  
  100.  
  101. Example:  uncat #?miamidx#? translations/miamidx.cd
  102.  
  103.  
  104. Important
  105. =========
  106.  
  107. - Start UnCat only once at a time !!!
  108.  
  109. - Don't use any other program that patches locale.library while UnCat is
  110.   running !!!
  111.  
  112. - The first line of the .cd file contains the catalog name and version. The
  113.   new catalog must be named exactly this way. If the version number is not 0
  114.   (zero) the new catalog must have exactly this version.
  115.  
  116.   Example: if the first line is
  117.  
  118.    ; xyz.catalog Version 2
  119.  
  120.    your new catalog must be named xyz.catalog and contain a version string like
  121.  
  122.    $VER: xyz.catalog 02.00 (20.04.01)
  123.  
  124.  
  125. - The strings in the .cd file are ordered by appearence, not by number. So this
  126.   could be a little confusing.
  127.  
  128. - UnCat runs asynchronously and uses pointers into the monitored program's
  129.   memory, so this could lead to crashes. If the monitored program crashes,
  130.   you can still stop UnCat and use the .cd file. If UnCat crashes, bad luck.
  131.   Please tell me the program you monitored and the action you did before the
  132.   crash.
  133.  
  134. - If your .cd file remains empty, the TASK pattern you entered did not match. 
  135.   Try enclosing it in #?. For DOS processes (Shell windows) the program name
  136.   like entered in the DOS window or Shell script is used, including path. For 
  137.   workbench tasks only the program name like shown below the icon is used.
  138.  
  139. - If the monitored program uses localised system functions (like file requestors
  140.   or system failures) those stings might apear in the .cd file. Try to remove
  141.   them as they are misplaced here.
  142.  
  143.  
  144. Messages
  145. ========
  146.  
  147. invalid pattern for task
  148.  
  149.     The pattern you entered for TASK contains an error. Correct it and try
  150.     again.
  151.  
  152.  
  153. cannot create port
  154.  
  155.     UnCat could not create a message port. Usualy not enough memory (see there).
  156.  
  157.  
  158. not enough memory
  159.  
  160.     The number you entered for MAXID is too large. UnCat needs four times of
  161.     MAXID bytes of memory. If you didn't enter MAXID, try a number smaller than
  162.     5000 for MAXID.
  163.  
  164.  
  165. cannot open output file
  166.  
  167.     The file you specified as destination could not be opened. Correct the 
  168.     file name and try again.
  169.  
  170.  
  171. uncat installed
  172. press Ctrl-C to quit
  173.  
  174.     UnCat has installed its patches and is waiting for incoming messages.
  175.  
  176.  
  177. invalid message received
  178.  
  179.     Some other program is using UnCat's message port. Should never happen.
  180.  
  181.  
  182. uncat ended
  183.  
  184.     This message is issued always before exiting, showing a normal end of
  185.     the program.
  186.  
  187.  
  188. ============================= Archive contents =============================
  189.  
  190. Original  Packed Ratio    Date     Time    Name
  191. -------- ------- ----- --------- --------  -------------
  192.     8492    5526 34.9% 15-Jul-01 11:51:10  uncat
  193.     5202    2233 57.0% 15-Jul-01 11:57:44  uncat.readme
  194. -------- ------- ----- --------- --------
  195.    13694    7759 43.3% 16-Jul-101 20:03:36   2 files
  196.